Skip to main content

ThingPark X IoT Flow API

API Structure​

The ThingPark X IoT Flow API exposes 6 resources:

  • DRIVER
  • CODEC
  • CONNECTOR
  • CONNECTION
  • FLOW
  • EVENT

The following table gives a definition of each Group of API:

ResourceDescription
DriverThis resource contains a set of endpoints that describes available drivers.
CodecThis resource contains a set of endpoints used to manually encode/decode payloads.
ConnectorThis resource contains a set of endpoints which describe available connectors (AWS Amazon, Microsoft Azure and MQTT)
ConnectionThis resource contains a set of endpoints used to manage your connection to an IoT cloud platform, as well as state and metrics statistics from your connection can be collected here.
FlowThis resource contains a set of endpoints used to manage the relationship between a set of Devices and a set of connections.
EventThis resource can be used to retrieve events :
  • Events which occurred during a specified time range.
  • Events of a connection, if it has been stopped or restarted.
  • Errors occurring during the IoT Flow setup or execution.

Authentication Process​

To start using the API, you need to be authenticated on the DX API framework, using standard OAuth2. Each request is verified for authentication using Dx-Admin API

Full API documentation can be found here: Dx-Admin documentation

Getting Started Using the REST API with the Swagger UI​

Swagger is a tool which allows to use any API documented with a Swagger signature without coding. There are two environments which you can use to develop your Web-service application:

  • The Community environment
  • The Production environment

The Community environment should be used to develop and debug the Webservices. In this environment, you may use beta versions of API which are more recent than “Latest” (the most recent production version). ThingPark SaaS customers are notified by email when new beta and pre-production versions of DX are released. In order to test them, you must explicitly set the new API version (“latest” is switched to the new API only at the end of the Beta/Preprod validation period). The Production environment should be used only for stable applications and point to “latest” API version. The URL of the production environment depends of your instance name :

The Community environment is available using this URL:

The following screen is an example of the SWAGGER UI.